From ec7c2acf7bf39af5f2ed9e9c1beb8ae7d3abd09b Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Tue, 12 Oct 2010 09:45:11 -0400 Subject: [PATCH] Move GdkVisualType docs inline --- docs/reference/gdk/tmpl/visuals.sgml | 2 +- gdk/gdkvisual.h | 30 +++++++++++++++++++++------- 2 files changed, 24 insertions(+), 8 deletions(-) diff --git a/docs/reference/gdk/tmpl/visuals.sgml b/docs/reference/gdk/tmpl/visuals.sgml index cb20c0614d..96d3bea3b4 100644 --- a/docs/reference/gdk/tmpl/visuals.sgml +++ b/docs/reference/gdk/tmpl/visuals.sgml @@ -36,7 +36,7 @@ then %GDK_VISUAL_STATIC_GRAY. -#GdkColormap + diff --git a/gdk/gdkvisual.h b/gdk/gdkvisual.h index 80d742ff9a..714a0e666c 100644 --- a/gdk/gdkvisual.h +++ b/gdk/gdkvisual.h @@ -45,13 +45,29 @@ G_BEGIN_DECLS typedef struct _GdkVisualPrivate GdkVisualPrivate; typedef struct _GdkVisualClass GdkVisualClass; -/* Types of visuals. - * StaticGray: - * Grayscale: - * StaticColor: - * PseudoColor: - * TrueColor: - * DirectColor: +/** + * GdkVisualType: + * @GDK_VISUAL_STATIC_GRAY: Each pixel value indexes a grayscale value + * directly. + * @GDK_VISUAL_GRAYSCALE: Each pixel is an index into a color map that + * maps pixel values into grayscale values. The color map can be + * changed by an application. + * @GDK_VISUAL_STATIC_COLOR: Each pixel value is an index into a predefined, + * unmodifiable color map that maps pixel values into RGB values. + * @GDK_VISUAL_PSEUDO_COLOR: Each pixel is an index into a color map that + * maps pixel values into rgb values. The color map can be changed by + * an application. + * @GDK_VISUAL_TRUE_COLOR: Each pixel value directly contains red, green, + * and blue components. Use gdk_visual_get_red_pixel_details(), etc, + * to obtain information about how the components are assembled into + * a pixel value. + * @GDK_VISUAL_DIRECT_COLOR: Each pixel value contains red, green, and blue + * components as for %GDK_VISUAL_TRUE_COLOR, but the components are + * mapped via a color table into the final output table instead of + * being converted directly. + * + * A set of values that describe the manner in which the pixel values + * for a visual are converted into RGB values for display. */ typedef enum { -- 2.30.2